/**
 * @file      : kernel_list.h
 * @brief     : 内核链表头文件(从Linux内核中提取出来)
 * @author    : huenrong (huenrong1028@gmail.com)
 * @date      : 2021-04-09 15:40:45
 *
 * @copyright : Copyright (c) 2021 胡恩荣
 *
 */

#ifndef __KERNEL_LIST_H
#define __KERNEL_LIST_H

#include <stdio.h>

#define POISON_POINTER_DELTA 0

// 链表删除后, 指向的位置
// 这两个位置在系统中不能被访问, 访问会报错
// #define LIST_POISON1 ((void *)0x00100100 + POISON_POINTER_DELTA)
// #define LIST_POISON2 ((void *)0x00200200 + POISON_POINTER_DELTA)

// 为了在多平台兼容, 可以将其定义为NULL
#define LIST_POISON1 NULL
#define LIST_POISON2 NULL

/**
 * @brief  计算成员变量member在type(结构体)中的偏移地址
 * @param  type  : 输入参数, 结构体类型
 * @param  member: 输入参数, 结构体中的成员变量名
 */
#define offsetof(type, member) (size_t)(&((type *)0)->member)

// typeof是GNU中获取变量类型的关键字
/**
 * @brief  根据成员变量member的地址获取type(结构体)的起始地址
 * @param  ptr   : 输入参数, 指向成员变量member的指针
 * @param  type  : 输入参数, 结构体类型
 * @param  member: 输入参数, 结构体中的成员变量名
 */
#define container_of(ptr, type, member) ({          \
        const typeof(((type *)0)->member)*__mptr = (ptr);    \
        (type *)((char *)__mptr - offsetof(type, member)); })

// 链表结构
struct list_head
{
    struct list_head *next;
    struct list_head *prev;
};

#define LIST_HEAD_INIT(name) \
    {                        \
        &(name), &(name)     \
    }

// TODO: 初始化链表头节点
#define LIST_HEAD(name) \
    struct list_head name = LIST_HEAD_INIT(name)

// TODO: 初始化链表头节点
static inline void INIT_LIST_HEAD(struct list_head *list)
{
    list->next = list;
    list->prev = list;
}

/**
 * @brief  在两个已知的连续节点之间插入新的节点(仅限内部使用)
 * @param  new : 输出参数, 待插入的新节点
 * @param  prev: 输出参数, 已知的前一个节点
 * @param  next: 输出参数, 已知的后一个节点
 */
static inline void __list_add(struct list_head *new,
                              struct list_head *prev,
                              struct list_head *next)
{
    next->prev = new;
    new->next = next;
    new->prev = prev;
    prev->next = new;
}

// TODO: 插入节点(头插法)
/**
 * @brief  插入节点(头插法)
 * @param  new : 输出参数, 待插入的新节点
 * @param  head: 输出参数, 链表头节点
 */
static inline void list_add(struct list_head *new, struct list_head *head)
{
    __list_add(new, head, head->next);
}

// TODO: 插入节点(尾插法)
/**
 * @brief  插入节点(尾插法)
 * @param  new : 输出参数, 待插入的新节点
 * @param  head: 输出参数, 链表头节点
 */
static inline void list_add_tail(struct list_head *new, struct list_head *head)
{
    __list_add(new, head->prev, head);
}

/**
 * @brief  删除两个已知的连续节点之间的节点(仅限内部使用)
 * @param  prev: 输出参数, 已知的前一个节点
 * @param  next: 输出参数, 已知的后一个节点
 */
static inline void __list_del(struct list_head *prev, struct list_head *next)
{
    next->prev = prev;
    prev->next = next;
}

// TODO: 删除节点
/**
 * @brief  删除指定节点
 * @param  entry: 输出参数, 待删除的节点
 */
static inline void list_del(struct list_head *entry)
{
    __list_del(entry->prev, entry->next);
    entry->next = LIST_POISON1;
    entry->prev = LIST_POISON2;
}

// TODO: 判断链表是否为空
/**
 * @brief  判断链表是否为空
 * @param  head: 输入参数, 带判断的链表
 * @return 0: 链表非空
 *         1: 链表为空
 */
static inline int list_empty(const struct list_head *head)
{
    return head->next == head;
}

// TODO: 根据成员变量member的地址获取type(结构体)的起始地址
/**
 * @brief  根据成员变量member的地址获取type(结构体)的起始地址
 * @param  ptr   : 输入参数, 指向成员变量member的指针(struct list_head指针)
 * @param  type  : 输入参数, 结构体类型
 * @param  member: 输入参数, 结构体中的成员变量名(结构体中list_head的名称)
 */
#define list_entry(ptr, type, member) \
    container_of(ptr, type, member)

// TODO: 从链表中获取第一个元素
/**
 * @brief  从链表中获取第一个元素
 * @param  ptr   : 输入参数, 从中获取元素的链表头
 * @param  type  : 输入参数, 结构体类型
 * @param  member: 输入参数, 结构体中的成员变量名(结构体中list_head的名称)
 */
#define list_first_entry(ptr, type, member) \
    list_entry((ptr)->next, type, member)

// TODO: 获取链表中的下一个元素
/**
 * @brief  获取链表中的下一个元素
 * @param  ptr   : 输入参数, 从中获取元素的链表头
 * @param  type  : 输入参数, 结构体类型
 * @param  member: 输入参数, 结构体中的成员变量名(结构体中list_head的名称)
 */
#define list_next_entry(pos, member) \
    list_entry((pos)->member.next, typeof(*(pos)), member)

// TODO: 遍历链表
/**
 * @brief  遍历链表
 * @param  pos : 输出参数, 遍历得到的链表节点(struct list_head *类型指针)
 * @param  head: 输入参数, 链表头(struct list_head *类型指针)
 */
#define list_for_each(pos, head) \
    for (pos = (head)->next; pos != (head); pos = pos->next)

// TODO: 遍历给定类型的链表
/**
 * @brief  遍历给定类型的链表
 * @param  pos   : 输出参数, 遍历得到的链表节点(用户层定义结构体指针)
 * @param  head  : 输入参数, 链表头(struct list_head *类型指针)
 * @param  member: 输入参数, 结构体中list_head的名称
 */
#define list_for_each_entry(pos, head, member)               \
    for (pos = list_first_entry(head, typeof(*pos), member); \
         &pos->member != (head);                             \
         pos = list_next_entry(pos, member))

// TODO: 遍历给定类型的链表, 以防删除链表项
/**
 * @brief  遍历给定类型的链表, 以防删除链表项
 * @param  pos   : 输出参数, 遍历得到的链表节点(用户层定义结构体指针)
 * @param  n     : 输入参数, 临时变量(用户层定义结构体指针)
 * @param  head  : 输入参数, 链表头(struct list_head *类型指针)
 * @param  member: 输入参数, 结构体中list_head的名称
 */
#define list_for_each_entry_safe(pos, n, head, member)       \
    for (pos = list_first_entry(head, typeof(*pos), member), \
        n = list_next_entry(pos, member);                    \
         &pos->member != (head);                             \
         pos = n, n = list_next_entry(n, member))

// TODO: 替换节点(未断开old的前驱和后继)
/**
 * @brief  替换节点(未断开old的前驱和后继)
 * @param  old: 输出参数, 待替换的节点
 * @param  new: 输出参数, 待插入的节点
 */
static inline void list_replace(struct list_head *old,
                                struct list_head *new)
{
    new->next = old->next;
    new->next->prev = new;
    new->prev = old->prev;
    new->prev->next = new;
}

// TODO: 替换节点(断开old的前驱和后继)
/**
 * @brief  替换节点(断开old的前驱和后继)
 * @param  old: 输出参数, 待替换的节点
 * @param  new: 输出参数, 待插入的节点
 */
static inline void list_replace_init(struct list_head *old,
                                     struct list_head *new)
{
    list_replace(old, new);
    INIT_LIST_HEAD(old);
}

#endif // __KERNEL_LIST_H
